<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.9.4"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Flow-IPC: shm/stl/arena_activator.hpp Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr id="projectrow">
  <td id="projectalign">
   <div id="projectname">Flow-IPC<span id="projectnumber">&#160;2.0.0</span>
   </div>
   <div id="projectbrief">Flow-IPC project: Full implementation reference.</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.4 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search",'Search','.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div id="nav-path" class="navpath">
  <ul>
<li class="navelem"><a class="el" href="dir_ddb0f12d0722949f40b2818843b69123.html">shm</a></li><li class="navelem"><a class="el" href="dir_6227a2031bab796131cf8c4b0b895649.html">stl</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="headertitle"><div class="title">arena_activator.hpp</div></div>
</div><!--header-->
<div class="contents">
<a href="arena__activator_8hpp.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno">    1</span><span class="comment">/* Flow-IPC: Shared Memory</span></div>
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno">    2</span><span class="comment"> * Copyright 2023 Akamai Technologies, Inc.</span></div>
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno">    3</span><span class="comment"> *</span></div>
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno">    4</span><span class="comment"> * Licensed under the Apache License, Version 2.0 (the</span></div>
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno">    5</span><span class="comment"> * &quot;License&quot;); you may not use this file except in</span></div>
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno">    6</span><span class="comment"> * compliance with the License.  You may obtain a copy</span></div>
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno">    7</span><span class="comment"> * of the License at</span></div>
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno">    8</span><span class="comment"> *</span></div>
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno">    9</span><span class="comment"> *   https://www.apache.org/licenses/LICENSE-2.0</span></div>
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno">   10</span><span class="comment"> *</span></div>
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno">   11</span><span class="comment"> * Unless required by applicable law or agreed to in</span></div>
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno">   12</span><span class="comment"> * writing, software distributed under the License is</span></div>
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno">   13</span><span class="comment"> * distributed on an &quot;AS IS&quot; BASIS, WITHOUT WARRANTIES OR</span></div>
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno">   14</span><span class="comment"> * CONDITIONS OF ANY KIND, either express or implied.</span></div>
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno">   15</span><span class="comment"> * See the License for the specific language governing</span></div>
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno">   16</span><span class="comment"> * permissions and limitations under the License. */</span></div>
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno">   17</span><span class="comment"></span> </div>
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno">   18</span><span class="comment">/// @file</span></div>
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno">   19</span><span class="comment"></span><span class="preprocessor">#pragma once</span></div>
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno">   20</span> </div>
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno">   21</span><span class="preprocessor">#include &lt;flow/util/util.hpp&gt;</span></div>
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno">   22</span> </div>
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno"><a class="line" href="namespaceipc_1_1shm_1_1stl.html">   23</a></span><span class="keyword">namespace </span><a class="code hl_namespace" href="namespaceipc_1_1shm_1_1stl.html">ipc::shm::stl</a></div>
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno">   24</span>{</div>
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno">   25</span> </div>
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno">   26</span><span class="comment">// Types.</span></div>
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno">   27</span><span class="comment"></span> </div>
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno">   28</span><span class="comment">/**</span></div>
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno">   29</span><span class="comment"> * RAII-style class operating a stack-like notion of a the given *thread*&#39;s currently active SHM-aware</span></div>
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno">   30</span><span class="comment"> * `Arena`, so that Stateless_allocator knows which `Arena` is currently active w/r/t a given code context</span></div>
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno">   31</span><span class="comment"> * operating on a SHM-stored container instance.</span></div>
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno">   32</span><span class="comment"> *</span></div>
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno">   33</span><span class="comment"> * In its ctor, it activates the given `Arena*`.  In it dtor it re-activates the `Arena*` active at ctor time</span></div>
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno">   34</span><span class="comment"> * (or null if none was active).  Behavior is undefined if ctor and dtor are called from different threads.</span></div>
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno">   35</span><span class="comment"> *</span></div>
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno">   36</span><span class="comment"> * @see shm::stl namespace doc header for background.</span></div>
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno">   37</span><span class="comment"> * @see Stateless_allocator, the main class template that Arena_activator helps one use.</span></div>
<div class="line"><a id="l00038" name="l00038"></a><span class="lineno">   38</span><span class="comment"> */</span></div>
<div class="line"><a id="l00039" name="l00039"></a><span class="lineno">   39</span><span class="keyword">template</span>&lt;<span class="keyword">typename</span> Arena&gt;</div>
<div class="line"><a id="l00040" name="l00040"></a><span class="lineno"><a class="line" href="classipc_1_1shm_1_1stl_1_1Arena__activator.html">   40</a></span><span class="keyword">class </span><a class="code hl_class" href="classipc_1_1shm_1_1stl_1_1Arena__activator.html">Arena_activator</a> : <span class="keyword">private</span> <a class="code hl_class" href="classflow_1_1util_1_1Scoped__setter.html">flow::util::Scoped_setter</a>&lt;Arena*&gt;</div>
<div class="line"><a id="l00041" name="l00041"></a><span class="lineno">   41</span>{</div>
<div class="line"><a id="l00042" name="l00042"></a><span class="lineno">   42</span><span class="keyword">public</span>:</div>
<div class="line"><a id="l00043" name="l00043"></a><span class="lineno">   43</span>  <span class="comment">// Types.</span></div>
<div class="line"><a id="l00044" name="l00044"></a><span class="lineno">   44</span><span class="comment"></span> </div>
<div class="line"><a id="l00045" name="l00045"></a><span class="lineno">   45</span><span class="comment">  /// Short-hand for the `Arena` type this activates/deactivates in the current thread of ctor/dtor.</span></div>
<div class="line"><a id="l00046" name="l00046"></a><span class="lineno"><a class="line" href="classipc_1_1shm_1_1stl_1_1Arena__activator.html#a7b67cc75923884afa231be9b649ddd5d">   46</a></span><span class="comment"></span>  <span class="keyword">using </span><a class="code hl_typedef" href="classipc_1_1shm_1_1stl_1_1Arena__activator.html#a7b67cc75923884afa231be9b649ddd5d">Arena_obj</a> = Arena;</div>
<div class="line"><a id="l00047" name="l00047"></a><span class="lineno">   47</span> </div>
<div class="line"><a id="l00048" name="l00048"></a><span class="lineno">   48</span>  <span class="comment">// Constructors/destructor.</span></div>
<div class="line"><a id="l00049" name="l00049"></a><span class="lineno">   49</span><span class="comment"></span> </div>
<div class="line"><a id="l00050" name="l00050"></a><span class="lineno">   50</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00051" name="l00051"></a><span class="lineno">   51</span><span class="comment">   * Activates the given #Arena_obj.  `Stateless_allocator&lt;T, Arena&gt;` ops, as invoked by STL-compliant container</span></div>
<div class="line"><a id="l00052" name="l00052"></a><span class="lineno">   52</span><span class="comment">   * types parameterized on `Stateless_allocator&lt;T, Arena&gt;`, shall use that given arena for alloc/dealloc in the</span></div>
<div class="line"><a id="l00053" name="l00053"></a><span class="lineno">   53</span><span class="comment">   * calling thread until `*this` dtor is invoked.  The dtor shall restore the current `Arena*` (possibly null)</span></div>
<div class="line"><a id="l00054" name="l00054"></a><span class="lineno">   54</span><span class="comment">   * at time of entry to this ctor.</span></div>
<div class="line"><a id="l00055" name="l00055"></a><span class="lineno">   55</span><span class="comment">   *</span></div>
<div class="line"><a id="l00056" name="l00056"></a><span class="lineno">   56</span><span class="comment">   * Another `Arena_activator&lt;Arena_obj&gt;` can be used to activate/deactivate another #Arena_obj in stack-like</span></div>
<div class="line"><a id="l00057" name="l00057"></a><span class="lineno">   57</span><span class="comment">   * fashion.</span></div>
<div class="line"><a id="l00058" name="l00058"></a><span class="lineno">   58</span><span class="comment">   *</span></div>
<div class="line"><a id="l00059" name="l00059"></a><span class="lineno">   59</span><span class="comment">   * @param new_arena_not_null</span></div>
<div class="line"><a id="l00060" name="l00060"></a><span class="lineno">   60</span><span class="comment">   *        The #Arena_obj to activate.  Must not be null (else behavior undefined/assertion may trip).</span></div>
<div class="line"><a id="l00061" name="l00061"></a><span class="lineno">   61</span><span class="comment">   */</span></div>
<div class="line"><a id="l00062" name="l00062"></a><span class="lineno">   62</span>  <span class="keyword">explicit</span> <a class="code hl_function" href="classipc_1_1shm_1_1stl_1_1Arena__activator.html#a2ed251f580639100783a63e1d8a0689d">Arena_activator</a>(<a class="code hl_typedef" href="classipc_1_1shm_1_1stl_1_1Arena__activator.html#a7b67cc75923884afa231be9b649ddd5d">Arena_obj</a>* new_arena_not_null);</div>
<div class="line"><a id="l00063" name="l00063"></a><span class="lineno">   63</span><span class="comment"></span> </div>
<div class="line"><a id="l00064" name="l00064"></a><span class="lineno">   64</span><span class="comment">  /// See ctor.  This undoes what that did.</span></div>
<div class="line"><a id="l00065" name="l00065"></a><span class="lineno"><a class="line" href="classipc_1_1shm_1_1stl_1_1Arena__activator.html#a4d206ca25145e551b5cf8a01816335a7">   65</a></span><span class="comment"></span>  <a class="code hl_function" href="classipc_1_1shm_1_1stl_1_1Arena__activator.html#a4d206ca25145e551b5cf8a01816335a7">~Arena_activator</a>();</div>
<div class="line"><a id="l00066" name="l00066"></a><span class="lineno">   66</span> </div>
<div class="line"><a id="l00067" name="l00067"></a><span class="lineno">   67</span>  <span class="comment">// Methods.</span></div>
<div class="line"><a id="l00068" name="l00068"></a><span class="lineno">   68</span><span class="comment"></span> </div>
<div class="line"><a id="l00069" name="l00069"></a><span class="lineno">   69</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00070" name="l00070"></a><span class="lineno">   70</span><span class="comment">   * Returns the active arena, as understood by `Stateless_allocator&lt;Arena_obj&gt;` at this point in the calling</span></div>
<div class="line"><a id="l00071" name="l00071"></a><span class="lineno">   71</span><span class="comment">   * thread.  This is generally used by Stateless_allocator itself; but it is publicly exposed also, as it may</span></div>
<div class="line"><a id="l00072" name="l00072"></a><span class="lineno">   72</span><span class="comment">   * be of interest.</span></div>
<div class="line"><a id="l00073" name="l00073"></a><span class="lineno">   73</span><span class="comment">   *</span></div>
<div class="line"><a id="l00074" name="l00074"></a><span class="lineno">   74</span><span class="comment">   * @return See above.  Note this may be null.</span></div>
<div class="line"><a id="l00075" name="l00075"></a><span class="lineno">   75</span><span class="comment">   */</span></div>
<div class="line"><a id="l00076" name="l00076"></a><span class="lineno">   76</span>  <span class="keyword">static</span> <a class="code hl_typedef" href="classipc_1_1shm_1_1stl_1_1Arena__activator.html#a7b67cc75923884afa231be9b649ddd5d">Arena_obj</a>* <a class="code hl_function" href="classipc_1_1shm_1_1stl_1_1Arena__activator.html#afdce25994086de598aa4c880a6040763">this_thread_active_arena</a>();</div>
<div class="line"><a id="l00077" name="l00077"></a><span class="lineno">   77</span> </div>
<div class="line"><a id="l00078" name="l00078"></a><span class="lineno">   78</span><span class="keyword">private</span>:</div>
<div class="line"><a id="l00079" name="l00079"></a><span class="lineno">   79</span>  <span class="comment">// Data.</span></div>
<div class="line"><a id="l00080" name="l00080"></a><span class="lineno">   80</span><span class="comment"></span> </div>
<div class="line"><a id="l00081" name="l00081"></a><span class="lineno">   81</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00082" name="l00082"></a><span class="lineno">   82</span><span class="comment">   * See this_thread_active_arena.  The key point is it is thread-local and a separate object per distinct `Arena`</span></div>
<div class="line"><a id="l00083" name="l00083"></a><span class="lineno">   83</span><span class="comment">   * type.</span></div>
<div class="line"><a id="l00084" name="l00084"></a><span class="lineno">   84</span><span class="comment">   */</span></div>
<div class="line"><a id="l00085" name="l00085"></a><span class="lineno"><a class="line" href="classipc_1_1shm_1_1stl_1_1Arena__activator.html#a69544c72e7ca9b79e71e2d4a6c8f79e4">   85</a></span>  <span class="keyword">static</span> <span class="keyword">thread_local</span> <a class="code hl_typedef" href="classipc_1_1shm_1_1stl_1_1Arena__activator.html#a7b67cc75923884afa231be9b649ddd5d">Arena_obj</a>* <a class="code hl_variable" href="classipc_1_1shm_1_1stl_1_1Arena__activator.html#a69544c72e7ca9b79e71e2d4a6c8f79e4">s_this_thread_active_arena</a>;</div>
<div class="line"><a id="l00086" name="l00086"></a><span class="lineno">   86</span>}; <span class="comment">// class Arena_activator</span></div>
<div class="line"><a id="l00087" name="l00087"></a><span class="lineno">   87</span> </div>
<div class="line"><a id="l00088" name="l00088"></a><span class="lineno">   88</span><span class="comment">// Template static initializers.</span></div>
<div class="line"><a id="l00089" name="l00089"></a><span class="lineno">   89</span> </div>
<div class="line"><a id="l00090" name="l00090"></a><span class="lineno">   90</span><span class="keyword">template</span>&lt;<span class="keyword">typename</span> Arena&gt;</div>
<div class="line"><a id="l00091" name="l00091"></a><span class="lineno">   91</span><span class="keyword">thread_local</span> <span class="keyword">typename</span> <a class="code hl_typedef" href="classipc_1_1shm_1_1stl_1_1Arena__activator.html#a7b67cc75923884afa231be9b649ddd5d">Arena_activator&lt;Arena&gt;::Arena_obj</a>* <a class="code hl_variable" href="classipc_1_1shm_1_1stl_1_1Arena__activator.html#a69544c72e7ca9b79e71e2d4a6c8f79e4">Arena_activator&lt;Arena&gt;::s_this_thread_active_arena</a>(<span class="keyword">nullptr</span>);</div>
<div class="line"><a id="l00092" name="l00092"></a><span class="lineno">   92</span> </div>
<div class="line"><a id="l00093" name="l00093"></a><span class="lineno">   93</span><span class="comment">// Template implementations.</span></div>
<div class="line"><a id="l00094" name="l00094"></a><span class="lineno">   94</span> </div>
<div class="line"><a id="l00095" name="l00095"></a><span class="lineno">   95</span><span class="keyword">template</span>&lt;<span class="keyword">typename</span> Arena&gt;</div>
<div class="line"><a id="l00096" name="l00096"></a><span class="lineno"><a class="line" href="classipc_1_1shm_1_1stl_1_1Arena__activator.html#a2ed251f580639100783a63e1d8a0689d">   96</a></span><a class="code hl_function" href="classipc_1_1shm_1_1stl_1_1Arena__activator.html#a2ed251f580639100783a63e1d8a0689d">Arena_activator&lt;Arena&gt;::Arena_activator</a>(<a class="code hl_typedef" href="classipc_1_1shm_1_1stl_1_1Arena__activator.html#a7b67cc75923884afa231be9b649ddd5d">Arena_obj</a>* new_arena_not_null) :</div>
<div class="line"><a id="l00097" name="l00097"></a><span class="lineno">   97</span>  flow::util::Scoped_setter&lt;<a class="code hl_typedef" href="classipc_1_1shm_1_1stl_1_1Arena__activator.html#a7b67cc75923884afa231be9b649ddd5d">Arena_obj</a>*&gt;(&amp;s_this_thread_active_arena, std::move(new_arena_not_null))</div>
<div class="line"><a id="l00098" name="l00098"></a><span class="lineno">   98</span>{</div>
<div class="line"><a id="l00099" name="l00099"></a><span class="lineno">   99</span>  assert(<a class="code hl_function" href="classipc_1_1shm_1_1stl_1_1Arena__activator.html#afdce25994086de598aa4c880a6040763">this_thread_active_arena</a>()</div>
<div class="line"><a id="l00100" name="l00100"></a><span class="lineno">  100</span>         &amp;&amp; <span class="stringliteral">&quot;Per contract do not activate null.  Current arena is null only in the outside scope.&quot;</span>);</div>
<div class="line"><a id="l00101" name="l00101"></a><span class="lineno">  101</span>}</div>
<div class="line"><a id="l00102" name="l00102"></a><span class="lineno">  102</span> </div>
<div class="line"><a id="l00103" name="l00103"></a><span class="lineno">  103</span><span class="keyword">template</span>&lt;<span class="keyword">typename</span> Arena&gt;</div>
<div class="line"><a id="l00104" name="l00104"></a><span class="lineno">  104</span><a class="code hl_function" href="classipc_1_1shm_1_1stl_1_1Arena__activator.html#a4d206ca25145e551b5cf8a01816335a7">Arena_activator&lt;Arena&gt;::~Arena_activator</a>() = <span class="keywordflow">default</span>; <span class="comment">// Only declared to officially document it.</span></div>
<div class="line"><a id="l00105" name="l00105"></a><span class="lineno">  105</span> </div>
<div class="line"><a id="l00106" name="l00106"></a><span class="lineno">  106</span><span class="keyword">template</span>&lt;<span class="keyword">typename</span> Arena&gt;</div>
<div class="line"><a id="l00107" name="l00107"></a><span class="lineno"><a class="line" href="classipc_1_1shm_1_1stl_1_1Arena__activator.html#afdce25994086de598aa4c880a6040763">  107</a></span><span class="keyword">typename</span> <a class="code hl_typedef" href="classipc_1_1shm_1_1stl_1_1Arena__activator.html#a7b67cc75923884afa231be9b649ddd5d">Arena_activator&lt;Arena&gt;::Arena_obj</a>* <a class="code hl_function" href="classipc_1_1shm_1_1stl_1_1Arena__activator.html#afdce25994086de598aa4c880a6040763">Arena_activator&lt;Arena&gt;::this_thread_active_arena</a>() <span class="comment">// Static.</span></div>
<div class="line"><a id="l00108" name="l00108"></a><span class="lineno">  108</span>{</div>
<div class="line"><a id="l00109" name="l00109"></a><span class="lineno">  109</span>  <span class="keywordflow">return</span> s_this_thread_active_arena;</div>
<div class="line"><a id="l00110" name="l00110"></a><span class="lineno">  110</span>}</div>
<div class="line"><a id="l00111" name="l00111"></a><span class="lineno">  111</span> </div>
<div class="line"><a id="l00112" name="l00112"></a><span class="lineno">  112</span>} <span class="comment">// namespace ipc::shm::stl</span></div>
<div class="ttc" id="aclassflow_1_1util_1_1Scoped__setter_html"><div class="ttname"><a href="classflow_1_1util_1_1Scoped__setter.html">flow::util::Scoped_setter</a></div></div>
<div class="ttc" id="aclassipc_1_1shm_1_1stl_1_1Arena__activator_html"><div class="ttname"><a href="classipc_1_1shm_1_1stl_1_1Arena__activator.html">ipc::shm::stl::Arena_activator</a></div><div class="ttdoc">RAII-style class operating a stack-like notion of a the given thread's currently active SHM-aware Are...</div><div class="ttdef"><b>Definition:</b> <a href="arena__activator_8hpp_source.html#l00040">arena_activator.hpp:41</a></div></div>
<div class="ttc" id="aclassipc_1_1shm_1_1stl_1_1Arena__activator_html_a2ed251f580639100783a63e1d8a0689d"><div class="ttname"><a href="classipc_1_1shm_1_1stl_1_1Arena__activator.html#a2ed251f580639100783a63e1d8a0689d">ipc::shm::stl::Arena_activator::Arena_activator</a></div><div class="ttdeci">Arena_activator(Arena_obj *new_arena_not_null)</div><div class="ttdoc">Activates the given Arena_obj.</div><div class="ttdef"><b>Definition:</b> <a href="arena__activator_8hpp_source.html#l00096">arena_activator.hpp:96</a></div></div>
<div class="ttc" id="aclassipc_1_1shm_1_1stl_1_1Arena__activator_html_a4d206ca25145e551b5cf8a01816335a7"><div class="ttname"><a href="classipc_1_1shm_1_1stl_1_1Arena__activator.html#a4d206ca25145e551b5cf8a01816335a7">ipc::shm::stl::Arena_activator::~Arena_activator</a></div><div class="ttdeci">~Arena_activator()</div><div class="ttdoc">See ctor. This undoes what that did.</div></div>
<div class="ttc" id="aclassipc_1_1shm_1_1stl_1_1Arena__activator_html_a69544c72e7ca9b79e71e2d4a6c8f79e4"><div class="ttname"><a href="classipc_1_1shm_1_1stl_1_1Arena__activator.html#a69544c72e7ca9b79e71e2d4a6c8f79e4">ipc::shm::stl::Arena_activator::s_this_thread_active_arena</a></div><div class="ttdeci">static thread_local Arena_obj * s_this_thread_active_arena</div><div class="ttdoc">See this_thread_active_arena.</div><div class="ttdef"><b>Definition:</b> <a href="arena__activator_8hpp_source.html#l00085">arena_activator.hpp:85</a></div></div>
<div class="ttc" id="aclassipc_1_1shm_1_1stl_1_1Arena__activator_html_a7b67cc75923884afa231be9b649ddd5d"><div class="ttname"><a href="classipc_1_1shm_1_1stl_1_1Arena__activator.html#a7b67cc75923884afa231be9b649ddd5d">ipc::shm::stl::Arena_activator::Arena_obj</a></div><div class="ttdeci">Arena Arena_obj</div><div class="ttdoc">Short-hand for the Arena type this activates/deactivates in the current thread of ctor/dtor.</div><div class="ttdef"><b>Definition:</b> <a href="arena__activator_8hpp_source.html#l00046">arena_activator.hpp:46</a></div></div>
<div class="ttc" id="aclassipc_1_1shm_1_1stl_1_1Arena__activator_html_afdce25994086de598aa4c880a6040763"><div class="ttname"><a href="classipc_1_1shm_1_1stl_1_1Arena__activator.html#afdce25994086de598aa4c880a6040763">ipc::shm::stl::Arena_activator::this_thread_active_arena</a></div><div class="ttdeci">static Arena_obj * this_thread_active_arena()</div><div class="ttdoc">Returns the active arena, as understood by Stateless_allocator&lt;Arena_obj&gt; at this point in the callin...</div><div class="ttdef"><b>Definition:</b> <a href="arena__activator_8hpp_source.html#l00107">arena_activator.hpp:107</a></div></div>
<div class="ttc" id="anamespaceipc_1_1shm_1_1stl_html"><div class="ttname"><a href="namespaceipc_1_1shm_1_1stl.html">ipc::shm::stl</a></div><div class="ttdoc">ipc::shm sub-module providing integration between STL-compliant components (including containers) and...</div><div class="ttdef"><b>Definition:</b> <a href="arena__activator_8hpp_source.html#l00023">arena_activator.hpp:24</a></div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Fri Apr 11 2025 20:02:26 for Flow-IPC by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.4
</small></address>
</body>
</html>
